home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / language / pcl_src.zoo / extensions.lsp < prev    next >
Encoding:
Lisp/Scheme  |  1992-07-09  |  22.4 KB  |  497 lines
  1. ;;;-*-Mode:LISP; Package: PCL; Base:10; Syntax:Common-lisp; -*-
  2.  
  3. ;;;
  4. ;;; *************************************************************************
  5. ;;;
  6. ;;;   File: extensions.lisp.
  7. ;;;
  8. ;;;     by Trent E. Lange, Effective Date 04-23-92
  9. ;;;
  10. ;;;
  11. ;;;  This file contains a small set of useful extensions to PCL. 
  12. ;;;
  13. ;;; Permission is granted to any individual or institution to use, copy,
  14. ;;; modify and distribute this document.
  15. ;;;
  16. ;;; Suggestions, bugs, criticism and questions to lange@cs.ucla.edu
  17. ;;; *************************************************************************
  18. ;;;
  19.  
  20. (in-package 'pcl)
  21.  
  22. (eval-when (compile load eval)
  23.  
  24. (defvar *extensions-exports*
  25.         '(set-standard-instance-access
  26.           set-funcallable-instance-access
  27.  
  28.           funcallable-instance-slot-value
  29.           set-funcallable-instance-slot-value
  30.           funcallable-instance-slot-boundp
  31.           standard-instance-slot-value
  32.           set-standard-instance-slot-value
  33.           standard-instance-slot-boundp
  34.           structure-instance-slot-value
  35.           set-structure-instance-slot-value
  36.           structure-instance-slot-boundp
  37.  
  38.           #+pcl-user-instances
  39.           user-instance-slot-value
  40.           #+pcl-user-instances
  41.           set-user-instance-slot-value
  42.           #+pcl-user-instances
  43.           user-instance-slot-boundp
  44.  
  45.           with-optimized-slots
  46.           with-standard-instance-slots
  47.  
  48.           method-needs-next-methods-p
  49.           map-all-classes
  50.           finalize-all-classes
  51.  
  52.           updater
  53.           record-updater))
  54. )
  55.  
  56. (defclass updater ()
  57.   ((dependent :initarg :dependent :reader dependent)))
  58.  
  59. (defun record-updater (class dependee dependent &rest initargs)
  60.   (let ((updater
  61.          (apply #'make-instance class :dependent dependent initargs)))
  62.     (add-dependent dependee updater)
  63.     updater))
  64.  
  65.  
  66. (defun finalize-all-classes (&optional (root-name 't))
  67.   "Makes sure that all classes are finalized.  If Root-Name is supplied,
  68.    then finalizes Root-Name and all of its subclasses and their subclasses."
  69.   (map-all-classes #'(lambda (class)
  70.                        (unless (class-finalized-p class)
  71.                          (finalize-inheritance class)))
  72.                    root-name))
  73.  
  74.  
  75. ;;;
  76. ;;;
  77. ;;;
  78.  
  79.  
  80. (defmacro slot-value-from-index (instance wrapper slot-name slots index)
  81.   "Returns instance's slot-value given slot-name's index."
  82.   (once-only (index)
  83.     `(if ,index
  84.          (let ((val (%svref ,slots ,index)))
  85.            (if (eq val ',*slot-unbound*)
  86.                (slot-unbound (wrapper-class ,wrapper) ,instance ,slot-name)
  87.              val))
  88.          (if *safe-to-use-slot-value-wrapper-optimizations-p*
  89.              (get-class-slot-value-1 ,instance ,wrapper ,slot-name)
  90.              (accessor-slot-value ,instance ,slot-name)))))
  91.  
  92. (defmacro set-slot-value-from-index
  93.           (instance wrapper slot-name slots index new-value)
  94.   "Sets instance's slot-value to new-value given slot-name's index."
  95.   (once-only (index)
  96.     `(if ,index
  97.           (setf (%svref ,slots ,index) ,new-value)
  98.           (if *safe-to-use-set-slot-value-wrapper-optimizations-p*
  99.               (set-class-slot-value-1 ,instance ,wrapper ,slot-name ,new-value)
  100.               (setf (accessor-slot-value ,instance ,slot-name) ,new-value)))))
  101.  
  102. (defsetf slot-value-from-index set-slot-value-from-index)
  103.  
  104. (defmacro with-slots-slot-value-from-index
  105.           (instance wrapper slot-name slots index variable-instance)
  106.   "Returns instance's slot-value given slot-name's index."
  107.   (cond
  108.    ((consp wrapper)
  109.     `(let ((wrapper ,wrapper))
  110.        (unless (eq (wrapper-state wrapper) 't)
  111.          (setf wrapper (wrapper-state-trap wrapper ,instance)))
  112.        (with-slots-slot-value-from-index
  113.          ,instance wrapper ,slot-name ,slots ,index ,variable-instance)))
  114.    (variable-instance
  115.     `(let ((,instance ,variable-instance))
  116.        (with-slots-slot-value-from-index
  117.          ,instance ,wrapper ,slot-name ,slots ,index NIL)))
  118.    (T `(slot-value-from-index ,instance ,wrapper ,slot-name ,slots ,index))))
  119.  
  120. (defmacro set-with-slots-slot-value-from-index
  121.           (instance wrapper slot-name slots index variable-instance new-value)
  122.   "Sets instance's slot-value to new-value given slot-name's index."
  123.   (cond
  124.    ((consp wrapper)
  125.     `(let ((wrapper ,wrapper))
  126.        (unless (eq (wrapper-state wrapper) 't)
  127.          (setf wrapper (wrapper-state-trap wrapper ,instance)))
  128.        (set-with-slots-slot-value-from-index
  129.          ,instance wrapper ,slot-name ,slots ,index ,variable-instance
  130.          ,new-value)))
  131.    (variable-instance
  132.     `(let ((,instance ,variable-instance))
  133.        (set-with-slot-slots-value-from-index
  134.          ,instance ,wrapper ,slot-name ,slots ,index NIL ,new-value)))
  135.    (T
  136.     `(setf (slot-value-from-index ,instance ,wrapper ,slot-name ,slots ,index)
  137.            ,new-value))))
  138.  
  139. (defsetf with-slots-slot-value-from-index
  140.          set-with-slots-slot-value-from-index)
  141.  
  142. (defmacro with-slots-slot-value-from-wrapper-and-slots
  143.     (instance slot-name wrapper slots-layout slots variable-instance)
  144.   (cond
  145.    (variable-instance
  146.     `(let ((,instance ,variable-instance))
  147.        (with-slots-slot-value-from-wrapper-and-slots
  148.          ,instance ,slot-name ,wrapper ,slots-layout ,slots NIL)))
  149.    ((consp wrapper)
  150.     `(if *safe-to-use-slot-value-wrapper-optimizations-p*
  151.          (let ((wrapper ,wrapper))
  152.            (unless (eq (wrapper-state wrapper) 't)
  153.              (setf wrapper (wrapper-state-trap wrapper ,instance)))
  154.            (slot-value-from-wrapper-and-slots ,instance ,slot-name
  155.              wrapper ,slots-layout ,slots NIL))
  156.          (accessor-slot-value ,instance ,slot-name)))
  157.    (T
  158.     `(if *safe-to-use-slot-value-wrapper-optimizations-p*
  159.          (slot-value-from-wrapper-and-slots
  160.            ,instance ,slot-name ,wrapper ,slots-layout ,slots NIL)
  161.          (accessor-slot-value ,instance ,slot-name)))))
  162.  
  163. (defmacro set-with-slots-slot-value-from-wrapper-and-slots
  164.     (instance slot-name wrapper slots-layout slots variable-instance new-value)
  165.   (cond
  166.    (variable-instance
  167.     `(let ((,instance ,variable-instance))
  168.        (set-with-slots-slot-value-from-wrapper-and-slots
  169.          ,instance ,slot-name ,wrapper ,slots-layout ,slots NIL ,new-value)))
  170.    ((consp wrapper)
  171.     `(if *safe-to-use-set-slot-value-wrapper-optimizations-p*
  172.          (let ((wrapper ,wrapper))
  173.            (unless (eq (wrapper-state wrapper) 't)
  174.              (setf wrapper (wrapper-state-trap wrapper ,instance)))
  175.            (setf (slot-value-from-wrapper-and-slots ,instance ,slot-name
  176.                     wrapper ,slots-layout ,slots NIL)
  177.                  ,new-value))
  178.          (setf (accessor-slot-value ,instance ,slot-name) ,new-value)))
  179.    (T
  180.     `(if *safe-to-use-set-slot-value-wrapper-optimizations-p*
  181.          (setf (slot-value-from-wrapper-and-slots
  182.                  ,instance ,slot-name ,wrapper ,slots-layout ,slots NIL)
  183.                ,new-value)
  184.          (setf (accessor-slot-value ,instance ,slot-name) ,new-value)))))
  185.  
  186. (defsetf with-slots-slot-value-from-wrapper-and-slots
  187.          set-with-slots-slot-value-from-wrapper-and-slots)
  188.  
  189. (defun tree-memq-p (item form)
  190.   (cond ((consp form)
  191.          (or (tree-memq-p item (car form))
  192.              (tree-memq-p item (cdr form))))
  193.         (T (eq item form)))) 
  194.  
  195. (defmacro with-optimized-slots (slot-entries instance-form &body body)
  196.   "Optimized version of With-Slots that is faster because it factors out
  197.    functions common to all slot accesses on the instance.  It has two
  198.    extensions to With-Slots: (1) the second value of slot-entries are
  199.    evaluated as forms rather than considered to be hard slot-names, allowing
  200.    access of variable slot-names.  (2) if a :variable-instance keyword is
  201.    the first part of the body, then the instance-form is treated as a variable
  202.    form, which is always expected to return an instance of the same class.
  203.    The value of the keyword must be an instance that is the same class as
  204.    instance-form will always return."
  205.   ;;  E.g. (with-optimized-slots (foo-slot
  206.   ;;                         (foo-slot-accessor     'foo-slot)
  207.   ;;                         (variable-slot-accessor variable-slot))
  208.   ;;                        instance
  209.   ;;                        :instance-form (car instances-of-same-class)
  210.   ;;         (loop for instance in objects-of-same-class
  211.   ;;               as  variable-slot in variable-slots
  212.   ;;               collect (list foo-slot
  213.   ;;                             foo-slot-accessor
  214.   ;;                             variable-slot-accessor)))
  215.   ;;   ==> (loop for instance in objects-of-same-class
  216.   ;;             as  variable-slot in variable-slots
  217.   ;;             collect (list (slot-value instance 'foo-slot)
  218.   ;;                           (slot-value instance 'foo-slot)
  219.   ;;                           (slot-value instance variable-slot)))
  220.   (build-with-optimized-slots-form slot-entries instance-form body))
  221.  
  222. (defmacro with-standard-instance-slots (slot-entries instance-form &body body)
  223.   "Optimized version of With-Slots that assumes that the instance-form
  224.    evaluates to a standard-instance.  The result is undefined if it does not.
  225.    With-standard-instance-slots is faster than With-Slots because it factors
  226.    out functions common to all slot accesses on the instance.  It has two
  227.    extensions to With-Slots: (1) the second value of slot-entries are
  228.    evaluated as forms rather than considered to be hard slot-names, allowing
  229.    access of variable slot-names.  (2) if a :variable-instance keyword is
  230.    the first part of the body, then the instance-form is treated as a variable
  231.    form, which is always expected to return an instance of the same class.
  232.    The value of the keyword must be an instance that is the same class as
  233.    instance-form will always return."
  234.   (build-with-optimized-slots-form slot-entries instance-form body 'std-instance))
  235.  
  236. (defun build-with-optimized-slots-form (slot-entries instance-form body
  237.                                         &optional instance-type)
  238.   (let* ((variable-instance
  239.            (if (eq (car body) :variable-instance)
  240.                (prog1
  241.                  (cadr body)
  242.                  (setf body (cddr body)))))
  243.          (hard-accessors
  244.            (let ((collect NIL))
  245.              (dolist (slot-entry slot-entries (nreverse collect))
  246.                (when (and (symbolp slot-entry)
  247.                           (tree-memq-p slot-entry body))
  248.                  (push (cons slot-entry slot-entry) collect))
  249.                (when (and (consp slot-entry)
  250.                           (constantp   (second slot-entry))
  251.                           (tree-memq-p (car slot-entry) body))
  252.                  (push (cons (car slot-entry) (second (second slot-entry)))
  253.                        collect)))))
  254.          (variable-accessors
  255.            (let ((collect NIL))
  256.              (dolist (slot-entry slot-entries (nreverse collect))
  257.                (when (and (consp slot-entry)
  258.                           (not (constantp (second slot-entry)))
  259.                           (tree-memq-p (car slot-entry) body))
  260.                  (push slot-entry collect))))))
  261.     (if *safe-to-use-slot-wrapper-optimizations-p*
  262.         (build-maybe-safe-w-o-s-v hard-accessors variable-accessors
  263.                                   instance-form body variable-instance
  264.                                   instance-type)
  265.         (build-with-accessor-s-v  hard-accessors variable-accessors
  266.                                   instance-form body variable-instance))))
  267.  
  268. (defun build-maybe-safe-w-o-s-v (hard-accessors variable-accessors
  269.                                  instance-form body variable-instance
  270.                                  instance-type)
  271.   (let* ((instance-string
  272.            (if (symbolp instance-form) (symbol-name instance-form) ""))
  273.          (instance-form-var
  274.            (if (and variable-instance (simple-eval-access-p instance-form))
  275.                instance-form
  276.              (gensym
  277.                (concatenate 'simple-string instance-string "-INSTANCE-FORM"))))
  278.          (prototype-form
  279.            (if variable-instance
  280.                (if (simple-eval-access-p variable-instance)
  281.                    variable-instance
  282.                  (gensym (concatenate 'simple-string "VARIABLE-INSTANCE"
  283.                                                      instance-string)))
  284.                instance-form-var))
  285.          (wrapper-var
  286.            (gensym (concatenate 'simple-string instance-string "-WRAPPER")))
  287.          (slots-var
  288.            (unless variable-instance
  289.              (gensym (concatenate 'simple-string instance-string "-SLOTS"))))
  290.          (type-var
  291.            (when (and variable-instance (not instance-type))
  292.              (gensym (concatenate 'simple-string instance-string "-TYPE"))))
  293.          (type-var-std 1)
  294.          (type-var-fsc 2)
  295.          #+pcl-user-instances
  296.          (type-var-user 3)
  297.          (slot-index-vars
  298.            (mapcar #'(lambda (slot-entry)
  299.                          (list (car slot-entry)
  300.                                (cdr slot-entry)
  301.                                (gensym (concatenate
  302.                                          'simple-string
  303.                                          (if (string= instance-string "")
  304.                                              "INSTANCE-FORM-"
  305.                                            instance-string)
  306.                                          (symbol-name (cdr slot-entry))
  307.                                          "-INDEX"))))
  308.                    (remove-duplicates hard-accessors :key #'cdr)))
  309.          (slots-layout-var
  310.            (gensym (concatenate 'simple-string "SLOTS-LAYOUT-" instance-string)))
  311.          (runtime-slots-form
  312.            (if variable-instance
  313.                (ecase instance-type
  314.                  (std-instance  `(std-instance-slots ,instance-form-var))
  315.                  (fsc-instance  `(fsc-instance-slots ,instance-form-var))
  316.                  #+pcl-user-instances
  317.                  (user-instance `(get-user-instance-slots ,instance-form-var))
  318.                  ((nil)
  319.                   `(case ,type-var
  320.                      (,type-var-std  (std-instance-slots ,instance-form-var))
  321.                      (,type-var-fsc  (fsc-instance-slots ,instance-form-var))
  322.                      #+pcl-user-instances
  323.                      (,type-var-user (get-user-instance-slots ,instance-form-var)))))
  324.                 slots-var))
  325.          (runtime-wrapper-form
  326.            (if variable-instance
  327.                (ecase instance-type
  328.                  (std-instance  `(std-instance-wrapper ,instance-form-var))
  329.                  (fsc-instance  `(fsc-instance-wrapper ,instance-form-var))
  330.                  #+pcl-user-instances
  331.                  (user-instance `(get-user-instance-wrapper ,instance-form-var))
  332.                  ((nil)
  333.                   `(case ,type-var
  334.                      (,type-var-std  (std-instance-wrapper ,instance-form-var))
  335.                      (,type-var-fsc  (fsc-instance-wrapper ,instance-form-var))
  336.                      #+pcl-user-instances
  337.                      (,type-var-user (get-user-instance-wrapper ,instance-form-var)))))
  338.                wrapper-var)))
  339.     (declare (type simple-string instance-string)
  340.              (type list          slot-index-vars))
  341.     `(let (,@(unless variable-instance
  342.               `((,instance-form-var ,instance-form)))
  343.            ,@(when (and variable-instance
  344.                         (not (eq prototype-form variable-instance)))
  345.                `((,prototype-form ,variable-instance)))
  346.            ,wrapper-var ,slots-layout-var
  347.            ,@(if variable-instance
  348.                  (if type-var `((type-var 0)))
  349.                  (list slots-var))
  350.            ,@(mapcar #'third slot-index-vars))
  351.        ,@(when type-var `((declare (type index ,type-var))))
  352.        (when *safe-to-use-slot-wrapper-optimizations-p*
  353.          ,@(ecase instance-type
  354.              (std-instance
  355.               `((setf ,wrapper-var (std-instance-wrapper ,prototype-form))
  356.                 ,@(unless variable-instance
  357.                    `((setf ,slots-var (std-instance-slots ,prototype-form))))))
  358.              (fsc-instance
  359.               `((setf ,wrapper-var (fsc-instance-wrapper ,prototype-form))
  360.                 ,@(unless variable-instance
  361.                    `((setf ,slots-var (fsc-instance-slots ,prototype-form))))))
  362.              #+pcl-user-instances
  363.              (user-instance
  364.               `((setf ,wrapper-var (get-user-instance-wrapper ,prototype-form))
  365.                 ,@(unless variable-instance
  366.                    `((setf ,slots-var (get-user-instance-slots ,prototype-form))))))
  367.              ((nil)
  368.              `((cond
  369.                 ((std-instance-p ,prototype-form)
  370.                  (setf ,wrapper-var (std-instance-wrapper ,prototype-form))
  371.                  ,(if variable-instance
  372.                       `(setf ,type-var ,type-var-std)
  373.                     `(setf ,slots-var (std-instance-slots ,prototype-form))))
  374.                 ((fsc-instance-p ,prototype-form)
  375.                  (setf ,wrapper-var (fsc-instance-wrapper ,prototype-form))
  376.                  ,(if variable-instance
  377.                       `(setf ,type-var ,type-var-fsc)
  378.                     `(setf ,slots-var (fsc-instance-slots ,prototype-form))))
  379.                 #+pcl-user-instances
  380.                 ((get-user-instance-p ,prototype-form)
  381.                  (setf ,wrapper-var (get-user-instance-wrapper ,prototype-form))
  382.                  ,(if variable-instance
  383.                       `(setf ,type-var ,type-var-user)
  384.                     `(setf ,slots-var (get-user-instance-slots ,prototype-form))))))))
  385.          ,@(if instance-type
  386.                (build-w-s-v-find-slot-indices wrapper-var slots-layout-var
  387.                   prototype-form slot-index-vars)
  388.                `((when ,wrapper-var
  389.                   ,@(build-w-s-v-find-slot-indices wrapper-var slots-layout-var
  390.                        prototype-form slot-index-vars)))))
  391.        (symbol-macrolet
  392.          (,@(mapcar
  393.               #'(lambda (slot-cons)
  394.                   `(,(car slot-cons)
  395.                      (with-slots-slot-value-from-index
  396.                         ,instance-form-var
  397.                         ,runtime-wrapper-form
  398.                         ',(cdr slot-cons)
  399.                         ,runtime-slots-form
  400.                         ,(third (assoc (car slot-cons) slot-index-vars
  401.                                        :test #'eq))
  402.                         ,(when (and variable-instance
  403.                                     (not (eq variable-instance
  404.                                              instance-form-var)))
  405.                            variable-instance))))
  406.               hard-accessors)
  407.           ,@(mapcar
  408.               #'(lambda (variable-cons)
  409.                   `(,(car variable-cons)
  410.                     (with-slots-slot-value-from-wrapper-and-slots
  411.                       ,instance-form-var
  412.                       ,(second variable-cons)
  413.                       ,runtime-wrapper-form
  414.                       ,slots-layout-var
  415.                       ,runtime-slots-form
  416.                       ,(when (and variable-instance
  417.                                   (not (eq variable-instance
  418.                                            instance-form-var)))
  419.                          variable-instance))))
  420.               variable-accessors))
  421.          ,@body))))
  422.  
  423. (defun build-w-s-v-find-slot-indices (wrapper-var slots-layout-var
  424.                                       prototype-form
  425.                                       slot-index-vars)
  426.   (declare (type list slot-index-vars))
  427.   `((unless (eq (wrapper-state ,wrapper-var) 't)
  428.       (setf ,wrapper-var
  429.             (wrapper-state-trap ,wrapper-var ,prototype-form)))
  430.     (setf ,slots-layout-var (wrapper-instance-slots-layout ,wrapper-var))
  431.     ,@(if (<= (length slot-index-vars) 2)
  432.           (mapcar
  433.             #'(lambda (slot-cons)
  434.                 `(setf ,(third slot-cons)
  435.                        (instance-slot-index-from-slots-layout
  436.                          ,slots-layout-var ',(second slot-cons))))
  437.             slot-index-vars)
  438.           ;; More than two slots, so more efficient to search slots-layout-var
  439.           ;; only once, rather than once for each with instance-slot-index.
  440.           (labels
  441.             ((build-comps (slot-vars index)
  442.                (if slot-vars
  443.                    `(if (eq slot-name ',(second (car slot-vars)))
  444.                         (progn
  445.                           (setf ,(third (car slot-vars)) ,index)
  446.                           (if (= matches ,(1- (length slot-index-vars)))
  447.                               (go end-loop)
  448.                             (setf matches (the fixnum (1+ matches)))))
  449.                      ,(build-comps (cdr slot-vars) index)))))
  450.             `((block nil
  451.                 (let ((slots-left ,slots-layout-var)
  452.                       (slot-name  NIL)
  453.                       (index      0)
  454.                       (matches    0))
  455.                   (declare (type fixnum index matches))
  456.                   (when slots-left
  457.                     (tagbody
  458.                       begin-instance-slots-loop
  459.                         (setf slot-name (car slots-left))
  460.                         ,(build-comps slot-index-vars 'index)
  461.                         (setf index (the fixnum (1+ index)))
  462.                         (if (null (setf slots-left (cdr slots-left)))
  463.                             (go end-loop))
  464.                         (go begin-instance-slots-loop)
  465.                       end-loop)))))))))
  466.  
  467. (defun build-with-accessor-s-v (hard-accessors variable-accessors
  468.                                 instance-form body variable-instance)
  469.   ;; Build the body for with-optimized-slot-value when it is unsafe
  470.   ;; and accessor-slot-value must be used.
  471.   (let ((instance-form-var
  472.           (if variable-instance instance-form (gensym "INSTANCE-FORM"))))
  473.   `(let (,@(unless variable-instance
  474.             `((,instance-form-var ,instance-form))))
  475.      (symbol-macrolet
  476.        (,@(mapcar
  477.             #'(lambda (slot-cons)
  478.                 `(,(car slot-cons)
  479.                   (accessor-slot-value ,instance-form-var
  480.                                        ',(cdr slot-cons))))
  481.             hard-accessors)
  482.         ,@(mapcar
  483.             #'(lambda (variable-cons)
  484.                 `(,(car variable-cons)
  485.                   (accessor-slot-value ,instance-form-var
  486.                                        ,(second variable-cons))))
  487.             variable-accessors))
  488.        ,@body))))
  489.  
  490.  
  491. #-(or KCL IBCL)
  492. (export *extensions-exports* *the-pcl-package*)
  493.  
  494. #+(or KCL IBCL)
  495. (mapc 'export (list *extensions-exports*) (list *the-pcl-package*))
  496.  
  497.